home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 4 / BBS in a Box - Macintosh - Volume IV (January 1992) (BBS in a Box).iso / Files / Prog / M / LSC XCMD 2.0.cpt / Apple Originals / HyperXCmd.h / HyperXCmd.h
Encoding:
C/C++ Source or Header  |  1990-09-14  |  10.3 KB  |  248 lines  |  [TEXT/MPS ]
  1. /*
  2.     HyperXCmd.h
  3.     Definition file for HyperCard XCMDs and XFCNs in C.
  4.     Copyright Apple Computer, Inc.  1987-1990
  5.     All rights reserved
  6. */
  7.  
  8.  
  9. #ifndef  __HYPERXCMD__
  10. #define __HYPERXCMD__  1
  11.  
  12.  
  13. /* Unlike the old days, we have to make sure we have some definitions first… */
  14.  
  15. #ifndef  __TYPES__
  16. #include <Types.h>
  17. #endif
  18.  
  19. #ifndef __EVENTS__
  20. #include <events.h>
  21. #endif
  22.  
  23. #ifndef __MENUS__
  24. #include <Menus.h>
  25. #endif
  26.  
  27. #ifndef __TEXTEDIT__
  28. #include <TextEdit.h>
  29. #endif
  30.  
  31. #ifndef __PACKAGES__
  32. #include <Packages.h>
  33. #endif
  34.  
  35.  
  36.  
  37. /* result codes */
  38. #define xresSucc                0
  39. #define xresFail                1
  40. #define xresNotImp                2
  41.  
  42. /* XCMDBlock constants for event.what... */
  43. #define xOpenEvt                1000    /* the first event after you are created */
  44. #define xCloseEvt                1001    /* your window is being forced close (Quit?) */
  45. #define xGiveUpEditEvt            1002    /* you are losing Edit... */
  46. #define xGiveUpSoundEvt            1003    /* you are losing the sound channel... */
  47. #define xHidePalettesEvt        1004    /* someone called HideHCPalettes */
  48. #define xShowPalettesEvt        1005    /* someone called ShowHCPalettes */
  49. #define xEditUndo                1100    /* Edit——Undo */
  50. #define xEditCut                1102    /* Edit——Cut */
  51. #define xEditCopy                1103    /* Edit——Copy */
  52. #define xEditPaste                1104    /* Edit——Paste */
  53. #define xEditClear                1105    /* Edit——Clear */
  54. #define xSendEvt                1200    /* script has sent you a message (text) */
  55. #define xSetPropEvt                1201    /* set a window property */
  56. #define xGetPropEvt                1202    /* get a window property */
  57. #define xCursorWithin            1300    /* cursor is within the window */
  58. #define xMenuEvt                1400    /* user has selected an item in your menu */
  59. #define xMBarClickedEvt            1401    /* a menu is about to be shown--update if needed */
  60.  
  61. #define xShowWatchInfoEvt        1501    /* for variable and message watchers */
  62. #define xScriptErrorEvt            1502    /* place the insertion point */
  63. #define xDebugErrorEvt            1503    /* user clicked "Debug" at a complaint */
  64. #define xDebugStepEvt            1504    /* hilite the line */
  65. #define xDebugTraceEvt            1505    /* same as step but tracing */
  66. #define xDebugFinishedEvt        1506    /* script ended */
  67.  
  68. #define paletteProc                2048    /* Windoid with grow box */
  69. #define palNoGrowProc            2052    /* standard Windoid defproc */
  70. #define palZoomProc                2056    /* Windoid with zoom and grow */
  71. #define palZoomNoGrow            2060    /* Windoid with zoom and no grow */
  72. #define hasZoom                    8
  73. #define hasTallTBar                2
  74. #define toggleHilite            1
  75.  
  76.  
  77. #define maxCachedChecks            16        /* maximum number of checkpoints in a script */
  78.  
  79.  
  80. /* paramCount is set to these constants when first calling special XThings */
  81. #define xMessageWatcherID        = -2;
  82. #define xVariableWatcherID        = -3;
  83. #define xScriptEditorID            = -4;
  84. #define xDebuggerID                = -5;
  85.  
  86. /* XTalkObjectPtr->objectKind values */
  87. #define stackObj                1
  88. #define bkgndObj                2
  89. #define cardObj                    3
  90. #define fieldObj                4
  91. #define buttonObj                5
  92.  
  93.  
  94. typedef struct XCmdBlock *XCmdPtr; 
  95. struct XCmdBlock {
  96.     short paramCount;         /* If = -1 then new use for XWindoids */
  97.     Handle params[16];
  98.     Handle returnValue;
  99.     Boolean passFlag;
  100.  
  101.     Ptr entryPoint;             /* to call back to HyperCard */
  102.     short request;
  103.     short result;
  104.     long inArgs[8];
  105.     long outArgs[4];
  106. };
  107.  
  108. typedef struct XWEventInfo *XWEventInfoPtr; 
  109. struct XWEventInfo {
  110.     EventRecord event;
  111.     WindowPtr eventWindow;
  112.     long eventParams[9];
  113.     Handle eventResult;
  114. };
  115.  
  116. typedef struct XTalkObject *XTalkObjectPtr;
  117. struct XTalkObject {
  118.     short objectKind;        /* stack, bkgnd, card, field, or button */
  119.     long stackNum;            /* reference number of the source stack */
  120.     long bkgndID;
  121.     long cardID;
  122.     long buttonID;
  123.     long fieldID;
  124. };
  125.  
  126.  
  127. typedef struct CheckPts *CheckPtPtr;
  128. typedef CheckPtPtr *CheckPtHandle; 
  129. struct CheckPts {
  130.     short checks[maxCachedChecks];
  131. };
  132.  
  133.  
  134. /****  HyperTalk Utilities  ****/
  135. extern pascal Handle EvalExpr(XCmdPtr paramPtr, StringPtr expr);
  136. extern pascal void SendCardMessage(XCmdPtr paramPtr, StringPtr msg);
  137. extern pascal void SendHCMessage(XCmdPtr paramPtr, StringPtr msg);
  138.  
  139. /****  Memory Utilities  ****/
  140. extern pascal Handle GetGlobal(XCmdPtr paramPtr, StringPtr globName);
  141. extern pascal void SetGlobal(XCmdPtr paramPtr, StringPtr globName, Handle globValue);
  142. extern pascal void ZeroBytes(XCmdPtr paramPtr, Ptr dstPtr, long longCount);
  143.  
  144. /****  String Utilities  ****/
  145. extern pascal void ScanToReturn(XCmdPtr paramPtr, Ptr *scanPtr);
  146. extern pascal void ScanToZero(XCmdPtr paramPtr, Ptr *scanPtr);
  147. extern pascal Boolean StringEqual(XCmdPtr paramPtr, StringPtr str1, StringPtr str2);
  148. extern pascal long StringLength(XCmdPtr paramPtr, Ptr strPtr);
  149. extern pascal Ptr StringMatch(XCmdPtr paramPtr, StringPtr pattern, Ptr target);
  150. extern pascal void ZeroTermHandle(XCmdPtr paramPtr, Handle hndl);                                
  151.  
  152. /****  String Conversions  ****/
  153. extern pascal void BoolToStr(XCmdPtr paramPtr, Boolean bool, StringPtr str);
  154. extern pascal void ExtToStr(XCmdPtr paramPtr, extended num, StringPtr str);
  155. extern pascal void LongToStr(XCmdPtr paramPtr, long posNum, StringPtr str);
  156. extern pascal void NumToHex(XCmdPtr paramPtr, long num, short nDigits, StringPtr str);
  157. extern pascal void NumToStr(XCmdPtr paramPtr, long num, StringPtr str);
  158. extern pascal Handle PasToZero(XCmdPtr paramPtr, StringPtr str);
  159. extern pascal void PointToStr(XCmdPtr paramPtr, Point pt, StringPtr str);                        
  160. extern pascal void RectToStr(XCmdPtr paramPtr, Rect *rct, StringPtr str);                        
  161. extern pascal void ReturnToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  162. extern pascal Boolean StrToBool(XCmdPtr paramPtr, StringPtr str);
  163. extern pascal extended StrToExt(XCmdPtr paramPtr, StringPtr str);
  164. extern pascal long StrToLong(XCmdPtr paramPtr, StringPtr str);
  165. extern pascal long StrToNum(XCmdPtr paramPtr, StringPtr str);
  166. extern pascal void StrToPoint(XCmdPtr paramPtr, StringPtr str, Point *pt);                        
  167. extern pascal void StrToRect(XCmdPtr paramPtr, StringPtr str, Rect *rct);                        
  168. extern pascal void ZeroToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  169.  
  170. /****  Field Utilities  ****/
  171. extern pascal Handle GetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID);
  172. extern pascal Handle GetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag, StringPtr fieldName);
  173. extern pascal Handle GetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum);
  174. extern pascal void SetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  175.     Handle fieldVal);
  176. extern pascal void SetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
  177.     StringPtr fieldName, Handle fieldVal);
  178. extern pascal void SetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum,
  179.     Handle fieldVal);
  180. extern pascal TEHandle GetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  181.     short fieldNum, StringPtr fieldNamePtr);                                                    
  182. extern pascal void SetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  183.     short fieldNum, StringPtr fieldNamePtr, TEHandle fieldTE);                                    
  184.  
  185. /****  Miscellaneous Utilities  ****/
  186. extern pascal void BeginXSound(XCmdPtr paramPtr, WindowPtr window);
  187. extern pascal void EndXSound(XCmdPtr paramPtr);
  188. extern pascal Boolean GetFilePath(XCmdPtr paramPtr, StringPtr fileName, short numTypes, SFTypeList typeList,
  189.     Boolean askUser, OSType *fileType, StringPtr fullName);
  190. extern pascal void GetXResInfo(XCmdPtr paramPtr, short *resFile, short *resID, ResType *rType, StringPtr name);
  191. extern pascal void Notify(XCmdPtr paramPtr);
  192. extern pascal void SendHCEvent(XCmdPtr paramPtr, EventRecord *event);
  193. extern pascal void SendWindowMessage(XCmdPtr paramPtr, WindowPtr windPtr, 
  194.     StringPtr windowName, Handle msg);
  195. extern pascal WindowPtr FrontDocWindow(XCmdPtr paramPtr);
  196. extern pascal long StackNameToNum(XCmdPtr paramPtr, StringPtr stackName);
  197. extern pascal short ShowHCAlert(XCmdPtr paramPtr, short dlgID, StringPtr promptStr);
  198.  
  199. /****  Creating and Disposing XWindoids  ****/  /* ALL NEW */
  200. extern pascal WindowPtr NewXWindow(XCmdPtr paramPtr, Rect *boundsRect, StringPtr title, 
  201.    Boolean visible, short procID, Boolean color, Boolean floating);
  202. extern pascal WindowPtr GetNewXWindow(XCmdPtr paramPtr, ResType templateType, short 
  203.    templateID, Boolean color, Boolean floating);
  204. extern pascal void CloseXWindow(XCmdPtr paramPtr, WindowPtr window);
  205.  
  206. /****  XWindoid Utilities  ****/  /* ALL NEW */
  207. extern pascal void HideHCPalettes(XCmdPtr paramPtr);
  208. extern pascal void ShowHCPalettes(XCmdPtr paramPtr);
  209. extern pascal void RegisterXWMenu(XCmdPtr paramPtr, WindowPtr window, 
  210.     MenuHandle menu, Boolean registering);
  211. extern pascal void SetXWIdleTime(XCmdPtr paramPtr, WindowPtr window, long interval);
  212. extern pascal void XWHasInterruptCode(XCmdPtr paramPtr, WindowPtr window, Boolean haveCode);
  213. extern pascal void XWAlwaysMoveHigh(XCmdPtr paramPtr, WindowPtr window, Boolean moveHigh);
  214. extern pascal void XWAllowReEntrancy(XCmdPtr paramPtr, WindowPtr window, Boolean allowSysEvts, Boolean allowHCEvts);
  215.  
  216. /****  Text Editing Utilities  ****/  /* ALL NEW */
  217. extern pascal void BeginXWEdit(XCmdPtr paramPtr, WindowPtr window);
  218. extern pascal void EndXWEdit(XCmdPtr paramPtr, WindowPtr window);
  219. extern pascal Ptr HCWordBreakProc(XCmdPtr paramPtr);
  220. extern pascal void PrintTEHandle(XCmdPtr paramPtr, TEHandle hTE, StringPtr header);
  221.  
  222. /****  Script Editor support  ****/  /* ALL NEW */
  223. extern pascal CheckPtHandle GetCheckPoints(XCmdPtr paramPtr);
  224. extern pascal void SetCheckPoints(XCmdPtr paramPtr, CheckPtHandle checkLines);
  225. extern pascal void FormatScript(XCmdPtr paramPtr, Handle scriptHndl, long *insertionPoint, Boolean 
  226.     quickFormat);
  227. extern pascal void SaveXWScript(XCmdPtr paramPtr, Handle scriptHndl);
  228. extern pascal void GetObjectName(XCmdPtr paramPtr, XTalkObjectPtr object, StringPtr objName);
  229. extern pascal void GetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle *scriptHndl);
  230. extern pascal void SetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle scriptHndl);
  231.  
  232. /****  Debugging Tools support  ****/  /* ALL NEW */
  233. extern pascal void AbortScript(XCmdPtr paramPtr);
  234. extern pascal void GoScript(XCmdPtr paramPtr);
  235. extern pascal void StepScript(XCmdPtr paramPtr, Boolean stepInto);
  236. extern pascal void CountHandlers(XCmdPtr paramPtr, short *handlerCount);
  237. extern pascal void GetHandlerInfo(XCmdPtr paramPtr, short handlerNum, StringPtr handlerName, 
  238.    StringPtr objectName, short *varCount);
  239. extern pascal void GetVarInfo(XCmdPtr paramPtr, short handlerNum, short varNum, StringPtr varName, 
  240.    Boolean *isGlobal, StringPtr varValue, Handle varHndl);
  241. extern pascal void SetVarValue(XCmdPtr paramPtr, short handlerNum, short varNum, Handle varHndl);
  242. extern pascal Handle GetStackCrawl(XCmdPtr paramPtr);
  243. extern pascal void TraceScript(XCmdPtr paramPtr, Boolean traceInto);
  244.  
  245.  
  246. #endif       /* UsingHyperXCmd */
  247.  
  248.